home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1995 January / macformat-020.iso / Shareware City / Developers / GMS1.0b2 folder / ReadMe < prev   
Encoding:
Text File  |  1994-08-21  |  3.8 KB  |  86 lines  |  [TEXT/R*ch]
  1. GMSDK 1.0b1 Readme
  2.  
  3. The Gandreas Music System is a way to use QuickTime 2.0 to play music
  4. without having to do gory, QuickTime code.  It is designed to play music
  5. from resources in the background.  The interface is simple - only 6 calls
  6. (one to init, one to free up, one to play, one to call during idle, one
  7. to call during supsend, and one to call during resume), and wraps up all
  8. the Tune Component calls.  You also don't have to include Movies, QuickTimeComponents,
  9. Components, Files, etc... just the one interface file (GMSIntf.p or GMSIntf.h).
  10. Link in with GandreasMusicSystem.o and away you go.
  11.  
  12.  
  13. These calls are as follows:
  14. /*  Call this first, if it returns true, then music playing is possible  */
  15. pascal Boolean GMSInit();
  16.  
  17. /*  Call this to temporarily stop playback of the current music.  Should  */
  18. /*  be called on suspend events  */
  19. pascal void GMSPause();
  20.  
  21. /*  Call this to resume playback of the current music.  Call on resume  */
  22. /*  events  */
  23. pascal void GMSResume();
  24.  
  25. /*  This will clean up everything, release components, etc...  */
  26. pascal void GMSQuit();
  27.  
  28. /*  This is the actual routine to play a 'Musi' resource generated from  */
  29. /*  Midi2Musi.  It will lock it down for you - don't unlock or release  */
  30. /*  the resource until you are done playing.  If you want to stop playing  */
  31. /*  the current music and not play anything, pass NIL in  */
  32. pascal void GMSPlay (Handle h);
  33.  
  34. /*  Call this routine during your idle proc - it checks to see if the  */
  35. /*  music is done playing, and if so, causes it to repeat (don't call  */
  36. /*  this if you don't want your background music to repeat)  */
  37. pascal void GMSIdle();
  38.  
  39.  
  40. To create the resource for GMS to play, you can either use a music editor
  41. (that isn't completed yet, making this option difficult), or you can convert
  42. an existing MIDI file.  To do the latter option, simply drop the MIDI file
  43. on the application "Midi2Musi", select what instruments you want, and it
  44. will start playing it (to make sure everything worked).  Click the mouse to
  45. quit, and it will leave a "Musi" resource on the clipboard to paste into your
  46. resource file with ResEdit.
  47.  
  48. The format of this "Musi" resource is documented in a forthcoming MacTech article.
  49. Check the newstands for the October issue.  This library is also based on the
  50. techniques described there - see the article for a more in depth covering of
  51. playing music with QuickTime 2.0
  52.  
  53. If you decide to use GMS in a product (be it commercial, shareware, freeware,
  54. whatever), there is only two things you have to do:
  55.     1) In the "About box" (or wherever you have credits & copyrights), add the
  56.         line "Gandreas Music System © 1994, Glenn Andreas, All Rights Reserved."
  57.     2) When you finish the product, send a registerable copy to me at:
  58.         Glenn Andreas
  59.         171 83rd Ave NE #304
  60.         Fridley MN 55432-6822
  61.     By registerable, I mean a real version, not a demo.  If the product is
  62.     shareware, you need to mail it to me on floppy (not via email - if I wanted to
  63.     have to go through the hassle to download it, I could have done that anyway).
  64.     And if the shareware version needs to be "registered" to unlock some features,
  65.     include the code (as appropriate).
  66.  
  67. So there you are.   Everything you need to add background music to your latest
  68. project, at the cost of one line in an about box, and one finished product.
  69. It is, however, up to you to handle the licensing of "QuickTime™ 2.0" and the
  70. "QuickTime™ Musical Instruments"....
  71.  
  72. Glenn Andreas
  73. gandreas@aol.com
  74.  
  75. This work, including the GandreasMusicSystem.o library, the GMSIntf.p & GMSIntf.h
  76. header files, and the "Midi2Musi" application are:
  77. Copyright © 1994, Glenn Andreas. All Rights Reserved.
  78.  
  79. You may freely distribute this package, so long as all pieces are included
  80. and nothing is changed/omitted/added/or in any other way modified.
  81.  
  82.  
  83. Version History:
  84. 1.0b2    - First public release
  85.         Expanded this documentation
  86. 1.0b1    - First external release